<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Dimension Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">Dimension Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Base element for dimension elements within a cube.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Dimension</td></tr>
<tr><td>Since:</td>
<td>2.2</td></tr>
<tr><td>XML Element:</td>
<td><code>None</code></td></tr>
<tr><td>Extends:</td>
<td><a href="ReportElement.html">ReportElement</a></td></tr>
<tr><td>Extendable:</td>
<td>No</td></tr>
<tr><td>Abstract:</td>
<td>Yes</td></tr>
<tr><td>Name Space:</td>
<td>None</td></tr>
<tr><td>Name Requirement:</td>
<td>Required</td></tr>
<tr><td>Allows User Properties:</td>
<td>Yes</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-defaultHierarchy">defaultHierarchy</a></dt>
<dd>Name of the default hierarchy applied to this dimension.</dd>
<dt><a href="#Property-isTimeType">isTimeType</a></dt>
<dd>Indicates whether the data type of the dimension is time.</dd>
</dl>

<h3>Inherited Properties</h3>

<p class="section-text">
<a href="ReportElement.html#Property-comments">comments</a>, 
<a href="DesignElement.html#Property-customXml">customXml</a>, 
<a href="ReportElement.html#Property-displayName">displayName</a>, 
<a href="ReportElement.html#Property-displayNameID">displayNameID</a>, 
<a href="ReportElement.html#Property-eventHandlerClass">eventHandlerClass</a>, 
<a href="ReportElement.html#Property-extends">extends</a>, 
<a href="ReportElement.html#Property-name">name</a>, 
<a href="ReportElement.html#Property-newHandlerOnEachEvent">newHandlerOnEachEvent</a>, 
<a href="DesignElement.html#Property-propertyMasks">propertyMasks</a>, 
<a href="DesignElement.html#Property-userProperties">userProperties</a>, 
<a href="ReportElement.html#Property-viewAction">viewAction</a>
</p>
<h3>Description</h3>

<div class="section-text">
<p>The dimension is an abstract element that defines the 
basic properties of a OLAP dimension element. The derived elements, tabular and ODA dimension
elements, provide hierarchy contents that are defined in this dimension itself.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-defaultHierarchy">defaultHierarchy Property</a></h2>

<p class="section-text">Name of the default hierarchy applied to this dimension.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/Hierarchy.html">Hierarchy</a> Reference</td></tr>
<tr><td>Since:</td>
<td>2.2</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Default hierarchy</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The hierarchy element can define multiple hierarchy element. This property specified
the default one to be made query and rendered. If you don't set the value or give the value of
a non existing hierarchy, the first hierarchy element is read as the default one if existing.</p></div>

<hr>
<h2><a name="Property-isTimeType">isTimeType Property</a></h2>

<p class="section-text">Indicates whether the data type of the dimension is time.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.2</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Is time type</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>false</td></tr>
<tr><td>Inherited:</td>
<td>Yes</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>This property indicates whether this dimension is a special type of Time. This is used
to speed up the performance. True if the dimension is time type; otherwise false. By default, the
value is FALSE.</p></div>
</body>
</html>
